Improve the docs. (#157785, Torsten Schoenfeld)

2004-11-09  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkicontheme.[ch]: Improve the docs.  (#157785,
	Torsten Schoenfeld)

diff --git a/ChangeLog b/ChangeLog
index 50818a0fd122f9953ea27b7bbd6519dc77cab4b2..a6c02d5c80aa23ff6ec60c9edbbcea682a7ca185 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2004-11-09  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkicontheme.[ch]: Improve the docs.  (#157785,
+       Torsten Schoenfeld)
+
        * gdk/x11/gdkwindow-x11.c (gdk_window_get_geometry): Add
        a hint about using gdk_drawable_get_size() instead.
 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 50818a0fd122f9953ea27b7bbd6519dc77cab4b2..a6c02d5c80aa23ff6ec60c9edbbcea682a7ca185 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,8 @@
 2004-11-09  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkicontheme.[ch]: Improve the docs.  (#157785,
+       Torsten Schoenfeld)
+
        * gdk/x11/gdkwindow-x11.c (gdk_window_get_geometry): Add
        a hint about using gdk_drawable_get_size() instead.
 

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 50818a0fd122f9953ea27b7bbd6519dc77cab4b2..a6c02d5c80aa23ff6ec60c9edbbcea682a7ca185 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,5 +1,8 @@
 2004-11-09  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkicontheme.[ch]: Improve the docs.  (#157785,
+       Torsten Schoenfeld)
+
        * gdk/x11/gdkwindow-x11.c (gdk_window_get_geometry): Add
        a hint about using gdk_drawable_get_size() instead.
 

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 50818a0fd122f9953ea27b7bbd6519dc77cab4b2..a6c02d5c80aa23ff6ec60c9edbbcea682a7ca185 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,5 +1,8 @@
 2004-11-09  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkicontheme.[ch]: Improve the docs.  (#157785,
+       Torsten Schoenfeld)
+
        * gdk/x11/gdkwindow-x11.c (gdk_window_get_geometry): Add
        a hint about using gdk_drawable_get_size() instead.
 

diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index e095fc6cb1906a2527335b0ac5d0a06cfa4dd441..e5fa20106683f97f10742e22dfc5bdc1729eef57 100644 (file)
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -755,7 +755,8 @@ gtk_icon_theme_get_search_path (GtkIconTheme      *icon_theme,
  * @icon_theme: a #GtkIconTheme
  * @path: directory name to append to the icon path
  * 
- * Appends a directory to the search path. See gtk_icon_theme_set_search_path(). 
+ * Appends a directory to the search path. 
+ * See gtk_icon_theme_set_search_path(). 
  *
  * Since: 2.4
  **/
@@ -782,7 +783,8 @@ gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
  * @icon_theme: a #GtkIconTheme
  * @path: directory name to prepend to the icon path
  * 
- * Prepends a directory to the search path. See gtk_icon_theme_set_search_path().
+ * Prepends a directory to the search path. 
+ * See gtk_icon_theme_set_search_path().
  *
  * Since: 2.4
  **/
@@ -1420,7 +1422,8 @@ add_size (gpointer  key,
  * is zero-terminated.
  * 
  * Return value: An newly allocated array describing the sizes at
- * which the icon is available.
+ * which the icon is available. The array should be freed with g_free()
+ * when it is no longer needed.
  *
  * Since: 2.6
  **/
@@ -2790,7 +2793,7 @@ gtk_icon_info_get_display_name  (GtkIconInfo *icon_info)
  * that the icon is generally available.
  *
  * This function will generally be used with pixbufs loaded
- * via gdk_pixbuf_new_from_inline ().
+ * via gdk_pixbuf_new_from_inline().
  *
  * Since: 2.4
  **/

diff --git a/gtk/gtkicontheme.h b/gtk/gtkicontheme.h
index c97d7a130542bab1f0580f9faabfc68bcbd25586..aa41a99b2dcbbd29f16c847a5fef6881d8a288b2 100644 (file)
--- a/gtk/gtkicontheme.h
+++ b/gtk/gtkicontheme.h
@@ -64,8 +64,8 @@ struct _GtkIconThemeClass
  *   Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG.
  * @GTK_ICON_LOOKUP_USE_BUILTIN: When passed to
  *   gtk_icon_theme_lookup_icon() includes builtin icons
- *   as well as files. For a builtin icon, gdk_icon_info_get_filename()
- *   returns %NULL and you need to call gdk_icon_info_get_builtin_pixbuf().
+ *   as well as files. For a builtin icon, gtk_icon_info_get_filename()
+ *   returns %NULL and you need to call gtk_icon_info_get_builtin_pixbuf().
  * 
  * Used to specify options for gtk_icon_theme_lookup_icon()
  **/